home *** CD-ROM | disk | FTP | other *** search
/ Technotools / Technotools (Chestnut CD-ROM)(1993).ISO / os2tools / cpk2_099 / cpk2_099.doc < prev   
Text File  |  1991-10-01  |  10KB  |  241 lines
  1.                                Oberon CommPak/2 Dynamic Link Library
  2.         Asychronous Communications Routine Library for use with TE/2
  3.                                                         Version 0.99
  4.  
  5.                                                      Oberon Software
  6.                                                518 Blue Earth Street
  7.                                                    Mankato, MN 56001
  8.  
  9.                                            Voice Phone: 507/388-7001
  10.                                                    BBS: 507/388-1154
  11.                                            MCI Mail: oberon/413-5847
  12.                                                GEnie Mail: B.FLOWERS
  13.                                                      CIS: 72510,3500
  14.  
  15.                                                   September 28, 1991
  16.  
  17.   -------------------------------------------------------------
  18.  
  19.  Copyright 1991, Oberon Software, Mankato, MN - All Rights Reserved
  20.  
  21.   -------------------------------------------------------------
  22.  
  23.   This version of the file COMMPAK2.DLL is a replacement for the file
  24. of the same name which is distributed with the Oberon Terminal
  25. Emulator/2.  The dynalink library contains the routines which TE/2
  26. uses for its low and medium level access to the communication device,
  27. terminal emulation, and file transfer protocols.
  28.  
  29.   If you are currently using TE/2 version 1.10.C you must replace
  30. your existing COMMPAK2.DLL with this file.
  31.  
  32.   This version of COMMPAK2.DLL is NOT guaranteed to work with any
  33. version of TE/2 prior to version 1.10.C.  If you are using a version
  34. of TE/2 prior to 1.10.C, you should obtain the latest version. 
  35. Please contact Oberon Software if you are unable to locate a copy.
  36.  
  37.   Oberon Software will no longer officially support versions of TE/2
  38. prior to Version 1.10.C nor versions of COMMPAK2.DLL prior to Version
  39. 0.99.
  40.  
  41.   -------------------------------------------------------------
  42.  
  43.   The CommPak/2 Dynamic Link Library is a shareware product of
  44. Oberon Software.  You may freely use it in conjunction with TE/2 with
  45. no further registration commitment than is already implied by your
  46. use of TE/2.  If you are already a registered user of TE/2, use of
  47. this file is completely free.  If you have not registered TE/2, you
  48. are urged to do so, but this file is considered to be part of the
  49. shareware package and does not require its own separate registration.
  50.  
  51.   Enhancements to this library will occur from time to time
  52. independent of version releases of other Oberon Software products.
  53. The most current version of this library, so long as it is compatible
  54. with the current released version of TE/2, will always be available
  55. on the Oberon User Support BBS (507/388-1154, HST).  We will also
  56. make sure that new releases of this library appear on GEnie,
  57. Compuserve, BIX, and major BBSes around the world as they become
  58. available.
  59.  
  60.  
  61.   -------------------------------------------------------------
  62.  
  63.   INSTALLATION:
  64.  
  65.   If you have already installed TE/2 version 1.10.C, simply locate
  66. the file COMMPAK2.DLL on your hard disk and replace it with this copy
  67. of that file.  Please note that if TE/2 is currently running you must
  68. exit TE/2 before copying the new file over the existing one.  The
  69. next time you start TE/2 the new dynamic link library will be used.
  70.  
  71.   If you have not installed TE/2 version 1.10.C, please follow the
  72. installation instructions contained in the TE/2 documentation and
  73. then replace COMMPAK2.DLL as outlined in the previous paragraph.
  74.  
  75.  
  76.   -------------------------------------------------------------
  77.  
  78.  
  79.   WHAT'S NEW?
  80.  
  81.   File Transfer Protocols
  82.   =======================
  83.  
  84.   All of the file transfer protocols have been at least reworked;
  85. YModem upload, ASCII upload, and all of ZModem have been completely
  86. rewritten from the ground up based on the original ZModem spec.
  87. Thanks to Chris Laforet for his collaborative assistance with the
  88. ZModem re-write!
  89.  
  90.   All of the protocols, and specifically the batch protocols,
  91. YModem(g) and ZModem have been made completely HPFS aware (see notes
  92. below).
  93.  
  94.  
  95.   VT100
  96.   =====
  97.  
  98.   The VT100 emulation has under gone another round of enhancements
  99. and various problems with the screen handling have been corrected.
  100.  
  101.  
  102.   Extended Hardware Buffering
  103.   ===========================
  104.  
  105.   Support for Extended Hardware Buffering has been added to the DLL
  106. via a new entry point in the low-level CommXXX() API.  The protocols
  107. will make use of this feature if possible, TE/2 will also in its next
  108. release.
  109.  
  110.  
  111.   HPFS Awareness
  112.   ==============
  113.  
  114.   As mentioned, all of the protocols are longname aware and will
  115. accept any legal OS/2 filename which is legal on the target disk.
  116. The single file transfers assume that the user knows what s/he's
  117. doing and will not alter a filename that has been entered.  In this
  118. context, CIS B+ is categorized as a single file transfer because the
  119. user names each file individually.
  120.  
  121.   The batch protocols (Y and ZModem) now use DosFindFirst2() for file
  122. searches and will "find" files with long names while expanding wild
  123. card specs.  When Y or ZModem receives a file name from the remote
  124. sender, it is verified and possibly modified to make it legal for the
  125. target drive.  The following algorithm is used:
  126.  
  127.      1) In the process of removing an incoming path from the filename,
  128.         the character '/' is treated identically to the '\'.
  129.      2) If the first character of the filename is '"', the quote is
  130.         removed and the filename is parsed up to the next quote char-
  131.         acter or end of string (whichever comes first).
  132.      3) Any '*' or '?' characters in the name are replaced with '$'.
  133.      4) Any of the characters '|', '<', '>', comma, ':', and embedded
  134.         '"' characters are replaced with '!'.
  135.      5) The name is checked for validity on the target disk, if the
  136.         target is HPFS, it will at this point be valid and no further
  137.         processing is required.
  138.      6) If the name is not valid at this point, the current name will
  139.         be preserved and saved in the .LONGNAME EA for the resulting
  140.         file.
  141.      7) The characters '[', ']', '+', '=', and ';' are replaced with
  142.         '!'; all '.' characters in the name, except for the final one,
  143.         are replaced with '_' (if the name begins with '.', this dot
  144.         is changed to '@' instead).
  145.      8) Finally, the filename is made into an 8.3 filename by
  146.         truncating the portions before and after the dot.
  147.      9) If the name still not valid for whatever reason, the file is
  148.         renamed "transfer.fil".
  149.  
  150.  
  151.   -------------------------------------------------------------
  152.  
  153.   Notes Regarding TE2.INI Settings
  154.   ================================
  155.  
  156.   The following settings in TE2.INI are no longer used by the file
  157. transfer protocols:
  158.  
  159.              XMThreshold      XMPacing       XMRelax
  160.              YMThreshold      YMPacing       YMRelax
  161.              ZMThreshold      ZMPacing       ZMRelax
  162.              ZMTxFrameLen     ZMTxWindow
  163.              BPThreshold      BPPacing       BPRelax
  164.  
  165.   TE/2 will still accept the entries for these values in the TE2.INI
  166. file but they will have no effect on the behavior of the protocols.
  167.  
  168.   In the "AsciiUL" setting in TE2.INI, the meanings of the last two
  169. numeric parameters in the list have subtly changed.  They've been
  170. referred to as "ReadTimeout" and "WriteTimeout" however they are now
  171. both Write timeouts in essence, the first will be the timeout value
  172. the ASCII upload routine will use for reading arbitrary characters
  173. from the data stream and the second will be the amount of time it
  174. waits for the prompt character before giving up.  Both are expressed
  175. in milliseconds.
  176.  
  177.  
  178.   General Notes Regarding ASCII Upload
  179.   ====================================
  180.  
  181.   ASCII upload is really quite sensitive to the various settings.
  182. Setting the character timeout to zero and the prompt timeout to 5000
  183. seems to be fairly applicable in most situations (GEnie pushes the
  184. five seconds sometimes though getting you back to a line prompt!).
  185. On Maximus, uploading to the line editor, you can leave the pacings
  186. set to zero but uploading to Max's full screen editor (why would
  187. you?) you need to set character pacing rather high.  Magnum's line
  188. editor also requires a pretty hefty character pacing (~25ms).  MCI
  189. Mail and CIS both seemed to work pretty much as expected.  On Max,
  190. Magnum, and other BBSes that have line editors that do word wrap,
  191. it's a good idea not to upload stuff that will wrap - it get's the
  192. wait-for-prompt logic out of synch.
  193.  
  194.  
  195.   -------------------------------------------------------------
  196.  
  197.   We intend to document the API (Application Program Interface) for
  198. CommPak/2 and make it available to interested parties.  If you are
  199. interested in such a toolkit, fell free to contact Oberon Software
  200. via the Oberon BBS for information.
  201.  
  202.  
  203.   -------------------------------------------------------------
  204.  
  205.   The code contained in the accompanying file COMMPAK2.DLL ("the
  206. software") and this document are:
  207.  
  208.                 Copyright (c) 1990-1991
  209.                 by Oberon Software
  210.                 518 Blue Earth Street
  211.                 Mankato, MN 56001  USA
  212.  
  213.   Portions of the ZModem code are:
  214.  
  215.                 Copyright (c) 1991
  216.                 by Chris Laforet and Chris Laforet Software
  217.                 Graham, NC
  218.  
  219.   -------------------------------------------------------------
  220.  
  221.  
  222.   Use of this software for any purpose whatsoever constitutes your
  223. unqualified acceptance of the following statements.
  224.  
  225.   The author makes no warranty or representation that the software will
  226. be error free.  The author disclaims any warranties, either express or
  227. implied, including but not limited to any implied warranty of
  228. merchantability or fitness for any particular purpose.
  229.  
  230.   The user agrees to take full responsibility for the selection of and
  231. any use whatsoever made of the software.
  232.  
  233.  
  234.     IN NO EVENT WILL THE AUTHOR BE LIABLE FOR ANY DAMAGES WHATSOEVER
  235.   (INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS,
  236.   BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION OR THE LIKE)
  237.   ARISING OUT OF THE USE OF, INTERRUPTION IN THE USE OF, OR INABILITY
  238.   TO USE THIS SOFTWARE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF ANY
  239.   POSSIBILITY OR LIKELIHOOD OF SUCH DAMAGES.
  240.  
  241.